GetTableApplyListInApp
查询app下的未处理完的(加、修改、清理、删除、复制表数据)单据
未处理完的单据是指待审核的单据,及已审核生成了对应的事务,但事务也未完成的单据。 此接口仅提供查询功能,返回的信息也仅是单据的部分的信息。单据更详细的信息、及执行单据,请按各类型的单据的接口进行操作。
请求地址
POST
http://OmsAddress/app/newoms.php/webservice/business/table/get-table-apply-list-in-app?cmd=10010&ip-type=webservicerest&access-token=AccessTokenVal
POST请求参数说明
参数名称 | 数据类型 | 说明 | 是否必填字段 | 备注 |
---|---|---|---|---|
app_id | 整型 | 要查询的信息所在的app | 是 | |
zone_id | 整型 | 要查询的信息所在的zone | 否,默认指定app下的所有zone | |
table_name_list | 数组 | 要查询的表名列表 | 否,默认指定app下的所有table name | |
only_incomplete | 整型 | 是否只查询未完成的单据。1:是;0:否。 | 否,默认值为1 | |
only_apply_to_op_table | 整型 | 是否只查询表操作(加、修改、修改、删除、重建表)相关的单据。1:是;0:否。 | 否,默认值为1 |
Data参数
使用json格式表示记录相关信息,示例如下:
{
"app_id": 2,
"zone_id": 3
}
返回语法
返回参数说明
返回状态码不为200时,表示查询失败,返回数据为错误信息
返回状态码为200,表示查询成功,返回指定set_id,app_id的信息
注:返回值中apply_type与处理各类型的单据的接口命令字cmd对应如下:
单据类型 | 命令字(cmd) |
---|---|
加表(apply_type=0) | 10002 |
删除表(apply_type=1) | 10005 |
清理表(apply_type=2) | 10004 |
修改表(apply_type=3) | 10003 |
复制表数据(apply_type=7) | 10008 |
请求示例
通过 curl 方法发起请求
命令中的参数请参考本页中的“POST请求参数说明”,access-token的获取方法详见:获取access-token
curl -H "Content-type: application/json" -X "POST" -d '{
"app_id": 2,
"zone_id": 3
}' 'http://omsaddress/app/newoms.php/webservice/business/table/get-table-apply-list-in-app?cmd=10010&ip-type=webservicerest&access-token=<access-token>'
返回示例
成功返回示例
http请求的Status=200
[
{
"id": "112",
"set_id": "1",
"app_id": "2",
"zone_list": "3",
"table_name": "add_table5",
"table_type": "0",
"table_maxnum": "0",
"apply_type": "0",
"ext_zone_id": null,
"user": "yunwei_1",
"execute_status": "0",
"execute_user": "",
"trans_id": "",
"write_time": "2019-05-29 17:22:05"
}
]
错误返回
http请求的Status!=200
{
"name": "Unauthorized",
"message": "You are requesting with an invalid credential.",
"code": 0,
"status": 401,
"type": "yii\\web UnauthorizedHttpException"
}
{
"source_ip": "ip:10.29.89.51 not in whitelist"
}